Criar Taxa de Juros

Quando uma Taxa de Juros é criada com sucesso, a API retorna o código de status HTTP 201 Created, com os dados da Taxa de Juros criada no corpo da resposta.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos

Campo	Tipo	Descrição
installments	int	Número de parcelas aceitas
rate	int	Taxa de juros que será aplicada.

Requisição

POST https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables/{financingTableId}/rates JWT scope: financing-tables/write:financing-tables

Parâmetros

Nome	Tipo	Descrição
financingTableId	string	Identificador único da tabela de financiamento, no formato UUID.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
	"data": {
		"type": "financing-table-rates",
		"attributes": {
			"installments": 12,
			"rate": 0.0465
		}
	}
}

Respostas

Código	Descrição
201	Taxa de juros criada com sucesso. Retorna os dados da taxa de juros criada
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
	data: {
		type: "financing-table-rates",
		attributes: {
			installments: 12,
			rate: 0.0465
		}
	}
});

const requestOptions = {
  method: "POST",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables/3e1f2c17-576f-4203-b2b3-4940868f946b/rates",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables/3e1f2c17-576f-4203-b2b3-4940868f946b/rates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
	"data": {
		"type": "financing-table-rates",
		"attributes": {
			"installments": 12,
			"rate": 0.0465
		}
	}
}'

Exemplo de Sucesso

{
    "links": {
        "self": "'https://api-sandbox.catalisa.com.br/financial-products/api/v1/financing-tables/3e1f2c17-576f-4203-b2b3-4940868f946b/rates/f9efb8eb-8493-4b4c-9265-50993670d781"
    },
    "data": {
        "type": "financing-table-rates",
        "id": "f9efb8eb-8493-4b4c-9265-50993670d781",
        "attributes": {
            "financingTableId": "3e1f2c17-576f-4203-b2b3-4940868f946b",
            "installments": 12,
            "rate": 0.0465
        }
    }
}